home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1996 #15 / Monster Media Number 15 (Monster Media)(July 1996).ISO / renegade / rgns110.zip / RGNSHOW.DOC < prev    next >
Text File  |  1996-04-22  |  16KB  |  412 lines
  1.                            RGNSHOW version 1.10
  2.                                     by
  3.                             Charles D.  Gaefke
  4.  
  5.  
  6.                                 Disclaimer
  7.                                 ----------
  8.  
  9. The author of RGNSHOW is not responsible for any damaged, corrupted, lost,
  10. or otherwise harmful occurrences which may occur from the use or inability
  11. to use this program.  This program has been tested and retested, and
  12. debugged, by myself and others.  To the best of my knowledge, RGNSHOW has no
  13. bugs, and will not cause any corrupted or lost data on a properly configured
  14. BBS.  To the best of my knowledge, it will not do anything more than what is
  15. documented herein.  However, I guarantee NOTHING, except that this program
  16. will take up hard drive space.
  17.  
  18.  
  19.                                  WARRANTY
  20.                                  --------
  21.  
  22. NO WARRANTY IS GIVEN, EITHER EXPRESSED OR IMPLIED, AS TO THE FUNCTIONALITY
  23. OF THIS SOFTWARE PROGRAM.  BY USING THIS SOFTWARE, YOU ARE AGREEING NOT TO
  24. HOLD THE AUTHOR, CHARLES D. GAEFKE, RESPONSIBLE FOR ANY DAMAGES EITHER
  25. CONSEQUENTIAL OR INCIDENTAL, WHICH ARISE FROM YOUR ABILITY TO USE OR MISUSE
  26. THIS SOFTWARE PROGRAM.  YOU ARE FURTHER AGREEING, WITH YOUR USE OF THIS
  27. SOFTWARE PROGRAM, THAT YOU HAVE READ THIS ENTIRE DOCUMENT AND ARE FAMILIAR
  28. WITH ITS TERMS AND AGREE TO EXEMPT CHARLES D. GAEFKE FROM ANY AND ALL
  29. RESPONSIBILITIES IN THE EVENT OF ANY DAMAGES TO YOUR SYSTEM WHICH ARE CAUSED
  30. EITHER THROUGH DIRECT OR INDIRECT USE OF THIS SOFTWARE PROGRAM.
  31.  
  32.  
  33.                        Shareware Concept/Grant of License
  34.                        ----------------------------------
  35.  
  36. RGNSHOW is a a fully-functional (non-crippled) Shareware utility.  You are
  37. granted a limited license to use and evaluate RGNSHOW for a period not to
  38. exceed thirty (30) days from the date of your first use.  Like all shareware,
  39. you are expected to purchased a fully-licensed copy of RGNSHOW if you like
  40. it, and wish to continue using it after the evaluation period.  Registration
  41. is only $5.  Please see below for the registration form.
  42.  
  43. Use of RGNSHOW beyond the stated 30-day period from its first use without
  44. purchasing a registered license to use RGNSHOW is a violation of this end
  45. user license agreement, and a violation of the copyright held by the
  46. author.
  47.  
  48.  
  49.                                Distribution
  50.                                ------------
  51.  
  52. Feel free to distribute RGNSHOW among your sysop friends.  However, I do
  53. ask that do so only in unmodified format, in the distribution RGNS110.ZIP
  54. archive, that contains the following files:
  55.  
  56. RGNSHOW.EXE
  57. RGNSHOW.DOC
  58. FILE_ID.DIZ
  59. WHATS.NEW
  60.  
  61.  
  62.                             Purpose of RGNSHOW
  63.                             ------------------
  64.  
  65. The purpose of RGNSHOW is to allow multi-node systems to show on the node
  66. activity list in Renegade exactly what is going on in the background.
  67. Common uses are "Mail Tossing", "Nightly Maintenance", and "Packing Mail".
  68. But these are just examples.  You can make it read whatever you want.
  69.  
  70. RGNSHOW is also commonly used to update the user activity for a user
  71. playing a door game.  RGNSHOW can show on the node activity list exactly
  72. what the user is doing (via your parameters) without you passing all the
  73. information for that particular user to RGNSHOW.  All you have to do is
  74. give RGNSHOW a node #, the path to your RENEGADE.DAT, and it will do the
  75. rest. :)
  76.  
  77. The activity is listed in the Activity field in the node listing.
  78.  
  79.  
  80.                                Requirements
  81.                                ------------
  82.  
  83. RGNSHOW requires Renegade version 04-05-96.  Because RGNSHOW is commonly
  84. used with door games, you must be familiar with how to setup door games on
  85. your BBS.  I have provided two example of how to use RGNSHOW, but your
  86. needs may require more information than what I presented in the examples.
  87. And, since BBS's are run by batch files, batch file knowledge is required
  88. as well.  As for hardware requirements, RGNSHOW requires a 80386 processor,
  89. or better, to run.
  90.  
  91. RGNSHOW has been tested and it runs properly under DOS/Desqview and OS/2
  92. Warp.  Although RGNSHOW could work under other operating systems, such as
  93. Windows 95, I can not guarantee it will.
  94.  
  95.  
  96.                                 Parameters
  97.                                 ----------
  98.  
  99. C>RGNSHOW
  100.  
  101. Syntax:
  102.  
  103. RGNSHOW -R <Dir> -D <Activity> [-U <Name>] [-N x] [-A x] [-S M/F] [-# x] [-G/-I]
  104.  
  105.  
  106. Parameters:
  107.  
  108.  -R[enegade Directory]  Location of the Renegade directory.
  109.  -D[oing] <Activity>)   Activity.
  110.  -U[ser] <Name>         User name; default = "The Computer".  Optional.
  111.  -G[et]                 Uses user info from user online (for doors.)
  112.                         Must be last command.  Optional.
  113.  -N[ode] x              Active node; default = 2.  Optional.
  114.  -A[ge] x               Age; default = 4.  Optional.
  115.  -S[ex] M/F             Sex; default = F.  Optional.
  116.  -#                     User #; default = 1.  Optional.
  117.  -I[nactive]            Makes node inactive.  Must be last command.
  118.  
  119.  
  120.                            Parameter Description
  121.                            ---------------------
  122.  
  123. ■ Renegade directory (-R)
  124.     This parameter IS required for RGNSHOW to know where your 'mult' and
  125. 'data' directory is located.
  126.  
  127. ■ Activity (-D)
  128.     This parameter is also required.  This is what is listed in the Location
  129. field of the node listing.  The ONLY time this parameter is not required
  130. is when you are using the -Inactive option.
  131.  
  132. ■ User name (-U)
  133.     Defaults to "The Computer".  This is what is listed in the UserName
  134. field of the node listing.
  135.  
  136. ■ Get (-G)
  137.     When used, RGNSHOW reads the user's data from the node specified by the
  138. -N parameter, and updates the user's node listing with the activity specified
  139. by the -D parameter.  Note that -N is REQUIRED if -G is used.  All other
  140. parameters (-A, -#, -U, -S), if specified, are ignored.  This parameter
  141. MUST be the last parameter, if used.
  142.  
  143. ■ Node (-N)
  144.     Defaults to 2.  This is the node that "The Computer" is listed as being
  145. active on.  In the evaluation version, this is limited to 2.
  146.  
  147. ■ Age (-A)
  148.     Defaults to 4.  This is the 'Age' of the "The Computer".
  149.  
  150. ■ Sex (-S)
  151.     Defaults to Female.  This is the 'Sex' of the "The Computer".
  152.  
  153. ■ User Number (-#)
  154.     Defaults to #1.  This option seems silly, but it is used in the
  155. structures, so I threw it in.  The only purpose I have found of this is that
  156. if you are in the user editor while "The Computer" is active, this user
  157. will have a little note above it "Note: This user is active on node #x".
  158.  
  159. ■ Inactive (-I)
  160.     Makes the node inactive, essentially removing "The Computer" from the
  161. node listing.  This MUST be the last command if used.
  162.  
  163. Notes:
  164.  
  165. 1)  All these commands can be used in any order, except the Inactive option.
  166. 2)  The parameters are case insensitive.  That is, -i is the same as -I.
  167. 3)  The parameters can be proceeded by a slash or dash.  That is, /I is
  168.     the same as -I.
  169. 4)  If there is a space in the string parameters (-D and -U) you MUST use
  170.     quotes.  Example: -d "Nightly Maintenance"
  171. 5)  There MUST be a space between the parameter and the option.
  172.  
  173.  
  174.                                 Example #1
  175.                                 ----------
  176.  
  177. On my system, node 1 and 2 and for remote users, and node 3 is for local
  178. users.  Node 4 is what I use for "The Computer".  When I run mail tossing
  179. in the background, this is how I run RGNSHOW:
  180.  
  181. RGNSHOW -d "Tossing Mail" -n 4 -r c:\renegade
  182.  
  183. Now the node listing looks like:
  184.  
  185. ──┬───────────────────┬────────────────────┬──────────────────┬─────┬─────┬───
  186. N │User Name          │Location            │Activity          │Avail│ S:A │Min
  187. ──┴───────────────────┴────────────────────┴──────────────────┴─────┴─────┴───
  188. 1      -                    -                    -              -      -   -
  189. 2      -                    -                    -              -      -   -
  190. 3      -                    -                    -              -      -   -
  191. 4  The Computer        Over here            Tossing Mail        No    F:4    0
  192.  
  193.  
  194. When mail tossing is done, this is executed:
  195.  
  196. RGNSHOW -n 4 -r c:\renegade -I
  197.  
  198. Which makes its node listing vanish.
  199.  
  200.  
  201.                                 Example #2
  202.                                 ----------
  203.  
  204. When a user on node #1 enters a door game, such as Legend of the Red Dragon,
  205. I have Renegade pass the node # with %N, like so:
  206.  
  207. 1. Long descript :(L)egend of the Red Dragon
  208. 2. Short descript:(L)egend of the Red Dragon
  209. 3. Menu keys     :L
  210. 4. ACS required  :"s50"
  211. 5. Cmdkeys       :DG
  212. 6. Options       :lord.bat %N
  213.    Flags         :None
  214.  
  215. and this batch file is executed:
  216.  
  217. @echo off
  218. rgnshow -r c:\renegade -n %1 -D "Playing LORD" -g
  219. cd \LORD
  220. start.bat %1 %2 %3 %4 %5 %6
  221.  
  222.  
  223. Now the node listing looks like:
  224.  
  225. ──┬───────────────────┬────────────────────┬──────────────────┬─────┬─────┬───
  226. N │User Name          │Location            │Activity          │Avail│ S:A │Min
  227. ──┴───────────────────┴────────────────────┴──────────────────┴─────┴─────┴───
  228. 1   Mystic Dude         Canonsburg, PA       Playing LORD       N     M:19 31
  229. 2      -                    -                    -              -      -   -
  230. 3      -                    -                    -              -      -   -
  231. 4      -                    -                    -              -      -   -
  232.  
  233.  
  234.  
  235.                               Time Estimation
  236.                               ---------------
  237.  
  238. RGNShow calculates the local time from the DOS environment variable TZ.
  239. Most good BBS's should have this variable set already, since several
  240. popular programs make use of it (such as Tick).  If you do not currently
  241. use TZ, and are not located in the eastern time zone (see note #2),
  242. the TZ environment variable is not very difficult to add.
  243.  
  244. The TZ variable, is in the following format:
  245.  
  246. xxxNyyy
  247.  
  248. Where xxx is your time zone (ex: EST), N is the time zone difference between
  249. your zone and Greenwich, and yyy is the your time zone initials if/when you
  250. observe Daylight Savings time.  The yyy is not necessary - if it is omitted,
  251. it simply means you do not observe Daylight Savings time and the time
  252. will not be adjusted.
  253.  
  254. Set the variable in your AUTOEXEC.BAT, by adding this:
  255.  
  256. SET TZ=xxxNyyy
  257.  
  258. substituting xxxNyyy with your settings, of course.  For example, in my
  259. AUTOEXEC.BAT, I have:
  260.  
  261. SET TZ=EST5EDT
  262.  
  263.  
  264. Note 1:  If you are unsure what the time zone difference there is between
  265. your location and Greenwich, consider that the setting for Eastern Standard
  266. Time is EST5EDT.  If you live in California, you are three hours behind EST,
  267. so you'd use PST8PDT.
  268.  
  269. Note 2:  If TZ is not present, RGNSHOW assumes TZ=EST5EDT.
  270.  
  271.  
  272.                                Registration
  273.                                ------------
  274.  
  275. RGNSHOW is Shareware.  Shareware is based on the "try before you buy"
  276. concept of software marketing.  You may try RGNSHOW, and if you like it, you
  277. are obligated to purchase a fully licensed copy.  If you do not, you stop
  278. using it and delete it from your system.
  279.  
  280. Until RGNSHOW is registered, it will display "UNREGISTERED" every time it
  281. is run, and you will be limited to the use of 2 nodes ONLY.
  282.  
  283. Registration of RGNSHOW costs only US$5.00.  Upon registration:
  284.  
  285. 1) You will receive a registration key;
  286. 2) You will be supporting the shareware concept;
  287. 3) You will be encouraging me to write more utilities; and
  288. 4) All unregistered "features" will be removed.
  289.  
  290. To register, please print this form and mail it with your check or money
  291. order to:
  292.  
  293.             CHARLES D. GAEFKE
  294.             128 PLUM RUN ROAD
  295.             CANONSBURG, PA  15317
  296.  
  297. I will process your order for RGNSHOW upon receipt, and will deliver it
  298. immediately using the method you have specified.
  299.  
  300. International orders welcomed!  All personal checks, however, must be drawn
  301. in US funds on a US bank.  Canadian residents may obtain a money order in US
  302. funds at their local bank or post office.  Other countries please inquire at
  303. your local bank or postal office about an International Money Order (IMO).
  304.  
  305.                                 (cut here)
  306. ---------------------------------------------------------------------------
  307. Registration form for RGNSHOW version 1.10.
  308.  
  309.  
  310.   Your REAL name:
  311.  
  312.       Address #1:
  313.  
  314.       Address #2:
  315.  
  316. City, State, Zip:
  317.  
  318.          Country:
  319.  
  320.  
  321. I can send you your registration key two ways:
  322. 1) I can crash it to you via Netmail if you have an address that I have a
  323.    nodelist for.
  324. 2) I can call your BBS and upload it (leave data phone #).
  325.  
  326. Preference:
  327.  
  328.  
  329. These are not required, but I would appreciate you filling them out so I
  330. know exactly what types of systems RGNSHOW is running on.
  331.  
  332. Hardware
  333.              CPU:            RAM:
  334.  
  335.  
  336.  
  337. Enclosed is $____.
  338.  
  339.    [ ] Check      [ ] Money Order   [ ] International Money Order (IMO)
  340.  
  341. By signing below, I agree that by registering this program, I am in no way
  342. purchasing and am in no way granted partial ownership or rights to RGNSHOW.
  343. I am paying for a non-transferable license to use RGNSHOW on my system
  344. indefinitely and to support the author and the shareware marketing concept.
  345. In return for my payment, however, I expect to receive a registration key
  346. which will disable any unregistered "features" of RGNSHOW.
  347.  
  348. Signature: ______________________________   Date:  __/__/__
  349.  
  350. Please make check or money order payable to Charles D. Gaefke.
  351.  
  352. ---------------------------------------------------------------------------
  353.  
  354.  
  355.                                 Bug Reports
  356.                                 -----------
  357.  
  358. At the present time, there are no known bugs with RGNSHOW.  Hopefully there
  359. will never be any. :)
  360.  
  361. In the event that a bug is found, however, please let me know!  For me to
  362. fix it, I will require as much information as you can give me.  So, when
  363. contacting me about a bug, please include:
  364.  
  365. Your operating system and version;
  366. Version of Renegade you were using when the bug occurred;
  367. Command line parameters used when the bug occurred;
  368. Can you make RGNSHOW do this again?  If so, how?
  369. Any other information/comments you think will be helpful to me.
  370.  
  371.  
  372.                          Miscellaneous Information
  373.                          -------------------------
  374.  
  375. This is the second 'official' release of a program for me.  My first was
  376. GEMC, a program to keep a daily record of imported messages from GEcho.
  377. There are more programs in the making, and still more ideas I haven't
  378. started yet.
  379.  
  380. I am in no way affiliated with any group or company.  I author alone.
  381.  
  382. RGNSHOW was compiled with Borland C++ v 3.1 creating 80386 code.  That is,
  383. RGNSHOW requires a 386 to run.  If you are using a 286 or older, please,
  384. for your sake, and your users, upgrade.
  385.  
  386. Source code is NOT available for sale or study.
  387.  
  388. RGNSHOW is coded for the Renegade 04-05-96 structures.  As long as the
  389. structures do not change, RGNSHOW will work for any subsequent upgrade.  If
  390. a release does come out with modified structures, I'll release an update of
  391. RGNSHOW as soon as I get the structures for the upgrade.  RGNSHOW will NOT
  392. work with the 10-05-94 version of Renegade.
  393.  
  394. The latest version of RGNSHOW can always be FREQed as 'RGSNHOW' from
  395. 50:530/1 or 1:129/230.
  396.  
  397.  
  398.                   Suggestions, Questions, and/or comments
  399.                   ---------------------------------------
  400.  
  401. Questions and comments about RGNSHOW, or any of my software, may be sent
  402. to me via Netmail at 1:129/230@Fidonet.org or 50:530/1@RGSNet.  Or, if
  403. you prefer, you can snailmail me at
  404.  
  405. LOTL
  406. c/o Charles Gaefke
  407. 128 Run Road
  408. Canonsburg, PA  15317-9801.
  409.  
  410.  
  411. -C. Gaefke
  412.